Node / meshtastic / Meshtastic-Android / files / feature / discovery / README.md

Displaying Rendered • View raw • Download

The T383838:feature:discovery module implements Local Mesh Discovery: the app cycles the connected radio through a queue of LoRa modem presets, dwells on each for a configured duration while collecting packets, then persists and ranks the results so the user can see which preset (or beacon-advertised custom channel) has the most active mesh nearby. Sessions are stored via T383838DiscoveryDao and can be revisited, mapped, summarised (AI or algorithmic), and exported.

Targets: Android · JVM (Desktop) · iOS (via T383838meshtastic.kmp.feature convention plugin)

• T383838DiscoveryScanEngine — core scan engine. Cycles through a queue of T383838ScanTargets, dwells on each while collecting packets, and persists aggregated results via T383838DiscoveryDao.

• T383838DiscoveryScanState — state machine for the scan lifecycle: T383838Idle → Preparing → Shifting → [Reconnecting] → Dwell → … → Analysis → Complete, with T383838Cancelling/T383838Restoring/T383838Failed/T383838Paused side paths.

• T383838ScanTarget — one queue entry. T383838channel == null is a public-preset target; a non-null channel is a beacon-advertised custom channel: the engine tunes the radio's primary channel to that name+PSK (and region) for the dwell, then restores it.

• T383838DiscoveryRankingEngine (T383838scan/) — ranks preset results by unique node count, neighbor diversity, non-duplicate packet count, and SNR.

• T383838Check24GhzCapability (T383838scan/) — layered heuristic that determines whether the connected radio supports 2.4 GHz LoRa (SX1280), returning T383838Supported / T383838Unsupported / T383838Unknown.

Navigation entries are registered by T383838discoveryGraph() in T383838navigation/DiscoveryNavigation.kt (Navigation 3, T383838DiscoveryRoute.* keys).

Same Google-flavor Gemini Nano vs fallback split as T383838:feature:docs:

• T383838ai/DiscoverySummaryAiProvider — interface for natural-language session/preset summaries.

• T383838ai/AlgorithmicSummaryProvider — deterministic fallback delegating to T383838DiscoverySummaryGenerator. Registered with T383838binds = []; each platform binds the interface explicitly: the Android T383838google flavor binds T383838GeminiNanoSummaryProvider (in T383838:androidApp), while T383838fdroid, Desktop, and iOS bind the algorithmic provider.

• T383838ai/LoRaPresetReference — modem-preset reference data (bandwidth, spreading factor, link budget) used to enrich AI prompts and algorithmic summaries.

Multiplatform export path in T383838export/:

• T383838DiscoveryExporter — interface: T383838export(DiscoveryExportData): ExportResult (success = bytes + MIME type + filename).

• T383838DiscoveryReportFormatter — shared formatting of session/preset report lines and filenames.

• T383838rememberExportSaver() / T383838ExportSaverLauncher — T383838expect/T383838actual file-save seam per platform (T383838ExportSaver.android.kt → SAF document picker, T383838ExportSaver.jvm.kt → file dialog, T383838ExportSaver.ios.kt).

• T383838PdfDiscoveryExporter (androidMain) renders a PDF report; T383838TextDiscoveryExporter (jvmMain) renders plain text.

UI for port-37 Mesh Beacon join invitations (T383838ui/component/):

• T383838MeshBeaconInvitationCard — a received beacon offer with its advertised channel/region/preset; the user can survey the mesh first, join it, or dismiss. Shown on T383838DiscoveryScanScreen.

• T383838BeaconChannelsCard — scan-setup section listing distinct beacon-advertised custom channels; selecting a row adds a custom-channel T383838ScanTarget.

From T383838feature/discovery/build.gradle.kts (T383838commonMain):

• T383838core:common, T383838core:data, T383838core:database, T383838core:di, T383838core:model, T383838core:navigation, T383838core:network, T383838core:prefs, T383838core:repository, T383838core:resources, T383838core:service, T383838core:ui

• T383838kotlinx.collections.immutable

• T383838org.meshtastic:protobufs (Maven artifact)